home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / CIncludes / PCCardAdapterPlugin.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-17  |  8.3 KB  |  202 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        PCCardAdapterPlugin.h
  3.  
  4.      Contains:    PC Card Socket Service Plug-In Programming Interface
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.2
  8.  
  9.      Copyright:    © 1996-1998 by Apple Computer, Inc. and SystemSoft Corporation. All rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __PCCARDADAPTERPLUGIN__
  18. #define __PCCARDADAPTERPLUGIN__
  19.  
  20. #ifndef __MACTYPES__
  21. #include <MacTypes.h>
  22. #endif
  23. #ifndef __NAMEREGISTRY__
  24. #include <NameRegistry.h>
  25. #endif
  26. #ifndef __INTERRUPTS__
  27. #include <Interrupts.h>
  28. #endif
  29. #ifndef __PCCARD__
  30. #include <PCCard.h>
  31. #endif
  32.  
  33.  
  34.  
  35. #if PRAGMA_ONCE
  36. #pragma once
  37. #endif
  38.  
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42.  
  43. #if PRAGMA_IMPORT
  44. #pragma import on
  45. #endif
  46.  
  47. #if PRAGMA_STRUCT_ALIGN
  48.     #pragma options align=power
  49. #elif PRAGMA_STRUCT_PACKPUSH
  50.     #pragma pack(push, 2)
  51. #elif PRAGMA_STRUCT_PACK
  52.     #pragma pack(2)
  53. #endif
  54.  
  55.  
  56. /*------------------------------------------------------------------------------------
  57.   Types
  58. ------------------------------------------------------------------------------------*/
  59. /*    Interrupt Status Change bits*/
  60.  
  61.  
  62. enum {
  63.     kSCBatteryDead                = 0x01,                            /* Battery Dead Status Change*/
  64.     kSCBatteryLow                = 0x02,                            /* Battery Warning Status Change*/
  65.     kSCReady                    = 0x04,                            /* Ready Status Change*/
  66.     kSCCardDetect                = 0x08,                            /* Card Detect Status Change*/
  67.     kSCCardEjected                = 0x10,                            /* Card Ejected*/
  68.     kSCStatusChange                = 0x20,                            /* PC Card Status Change Signal Asserted*/
  69.     kSCRingIndicate                = 0x40                            /* PC Card Ring Indicate Signal Asserted*/
  70. };
  71.  
  72.  
  73. /*    IRQ bits */
  74.  
  75. enum {
  76.     kIRQLevelMask                = 0x1F,
  77.     kIRQInvalid                    = 0x20,
  78.     kIRQHigh                    = 0x40,
  79.     kIRQEnable                    = 0x80
  80. };
  81.  
  82.  
  83. /*    bits for adapter characteristics flags*/
  84.  
  85.  
  86. enum {
  87.     SS_ADPT_FLG_IND                = 0x01,                            /* indicators for write-protect, card lock,*/
  88.                                                                 /* battery status, busy status, and XIP*/
  89.                                                                 /* are shared for all sockets*/
  90.     SS_ADPT_FLG_PWR                = 0x02,                            /* if set indicates that the sockets*/
  91.                                                                 /* share the same power control*/
  92.     SS_ADPT_FLG_DBW                = 0x04,                            /* all windows on the adapter must use*/
  93.                                                                 /* the same Data Bus Width*/
  94.     SS_ADPT_FLG_CARDBUS            = 0x08,                            /* all sockets are CardBus PC Card capable*/
  95.     SS_ADPT_FLG_DMA                = 0x10,                            /* the adapter has DMA capability*/
  96.                                                                 /*    bits for adapter power characteristics*/
  97.     SS_ADPT_FLG_V33                = 0x20,                            /* adapter supports 3.3 volt power to socket*/
  98.     SS_ADPT_FLG_V50                = 0x40,                            /* adapter supports 5.0 volt power to socket*/
  99.     SS_ADPT_FLG_V12                = 0x80                            /* adapter supports 12.0 volt power to socket*/
  100. };
  101.  
  102.  
  103. /*------------------------------------------------------------------------------------
  104.   Calls exported by the Family
  105. ------------------------------------------------------------------------------------*/
  106. EXTERN_API_C( OSStatus )
  107. CSReportStatusChange            (const RegEntryID *        adapterRef,
  108.                                  PCCardSocket             whichSocket,
  109.                                  PCCardSCEvents         statusChange,
  110.                                  PCCardSocketStatus     socketStatus);
  111.  
  112. /*------------------------------------------------------------------------------------
  113.   Plugin Dispatch Table
  114. ------------------------------------------------------------------------------------*/
  115. typedef CALLBACK_API_C( OSStatus , SSValidateHardwareProc )(const RegEntryID *deviceID);
  116. typedef CALLBACK_API_C( OSStatus , SSInitializeProc )(const RegEntryID *deviceID, Boolean replacingOldDriver);
  117. typedef CALLBACK_API_C( OSStatus , SSSuspendProc )(const RegEntryID *deviceID);
  118. typedef CALLBACK_API_C( OSStatus , SSResumeProc )(const RegEntryID *deviceID);
  119. typedef CALLBACK_API_C( OSStatus , SSFinalizeProc )(const RegEntryID *deviceID, Boolean beingReplaced);
  120. typedef CALLBACK_API_C( OSStatus , SSInquireAdapterProc )(ItemCount *numberOfSockets, ItemCount *numberOfWindows, ItemCount *numberOfBridgeWindow, PCCardAdapterCapabilities *capabilities);
  121. typedef CALLBACK_API_C( OSStatus , SSInquireSocketProc )(PCCardSocket socket, ItemCount *numberOfWindows, PCCardSocketStatus *supportedSocketStatus, PCCardSCEvents *supportedStatusChange);
  122. typedef CALLBACK_API_C( OSStatus , SSGetSocketProc )(PCCardSocket socket, PCCardVoltage *Vcc, PCCardVoltage *Vpp, PCCardVoltage *Vs, PCCardInterfaceType *socketIF, PCCardCustomInterfaceID *customIFID, PCCardSocketStatus *socketStatus, PCCardSCEvents *SCEventsMask, PCCardIRQ *IRQ, PCCardDMA *DMA);
  123. typedef CALLBACK_API_C( OSStatus , SSSetSocketProc )(PCCardSocket socket, PCCardVoltage Vcc, PCCardVoltage Vpp, PCCardInterfaceType socketIF, PCCardCustomInterfaceID customIFID, PCCardSocketStatus statusReset, PCCardSCEvents SCEventsMask, PCCardIRQ IRQ, PCCardDMA DMA);
  124. typedef CALLBACK_API_C( OSStatus , SSResetSocketProc )(PCCardSocket socket);
  125. typedef CALLBACK_API_C( OSStatus , SSGetStatusProc )(PCCardSocket socket, PCCardSocketStatus *currentStatus, PCCardSocketStatus *changedStatus);
  126. typedef CALLBACK_API_C( OSStatus , SSInquireWindowProc )(PCCardSocket *socket, PCCardWindow window, PCCardWindowState *windowState, PCCardWindowSize *windowSize, PCCardWindowAlign *windowAlign);
  127. typedef CALLBACK_API_C( OSStatus , SSGetWindowProc )(PCCardSocket *socket, PCCardWindow window, PCCardWindowState *windowState, PhysicalAddress *startAddress, PCCardWindowSize *windowSize, PCCardWindowOffset *windowOffset, PCCardAccessSpeed *memSpeed);
  128. typedef CALLBACK_API_C( OSStatus , SSSetWindowProc )(PCCardSocket socket, PCCardWindow window, PCCardWindowState windowState, PhysicalAddress startAddress, PCCardWindowSize windowSize, PCCardWindowOffset windowOffset, PCCardAccessSpeed memSpeed);
  129. typedef CALLBACK_API_C( OSStatus , SSGetWindowOffsetProc )(PCCardSocket *socket, PCCardWindow window, PCCardWindowState *windowState, PCCardWindowOffset *windowOffset);
  130. typedef CALLBACK_API_C( OSStatus , SSSetWindowOffsetProc )(PCCardSocket socket, PCCardWindow window, PCCardWindowState windowState, PCCardWindowOffset windowOffset);
  131. typedef CALLBACK_API_C( OSStatus , SSInquireBridgeWindowProc )(PCCardSocket *socket, PCCardWindow window, PCCardWindowState *windowState, PCCardWindowSize *windowSize, PCCardWindowAlign *windowAlign);
  132. typedef CALLBACK_API_C( OSStatus , SSGetBridgeWindowProc )(PCCardSocket *socket, PCCardWindow window, PCCardWindowState *windowState, PhysicalAddress *startAddress, PCCardWindowSize *windowSize);
  133. typedef CALLBACK_API_C( OSStatus , SSSetBridgeWindowProc )(PCCardSocket socket, PCCardWindow window, PCCardWindowState windowState, PhysicalAddress startAddress, PCCardWindowSize windowSize);
  134. typedef CALLBACK_API_C( OSStatus , SSGetInterruptSetMemberProc )(PCCardSocket socket, InterruptSetMember *interruptSetMember);
  135. typedef CALLBACK_API_C( OSStatus , SSEjectCardProc )(PCCardSocket socket);
  136.  
  137. enum {
  138.     kServiceTypePCCardAdapter    = FOUR_CHAR_CODE('sock'),
  139.     kPCCardAdapterPluginVersion    = 0x00000001,
  140.     kPCCardAdapterPluginCurrentVersion = kPCCardAdapterPluginVersion
  141. };
  142.  
  143.  
  144. struct PCCardAdapterPluginHeader {
  145.     UInt32                             version;
  146.     UInt32                             reserved1;
  147.     UInt32                             reserved2;
  148.     UInt32                             reserved3;
  149. };
  150. typedef struct PCCardAdapterPluginHeader PCCardAdapterPluginHeader;
  151.  
  152. struct PCCardAdapterPluginDispatchTable {
  153.     PCCardAdapterPluginHeader         header;
  154.  
  155.     SSValidateHardwareProc             validateHardware;
  156.  
  157.     SSInitializeProc                 initialize;
  158.     SSSuspendProc                     suspend;
  159.     SSResumeProc                     resume;
  160.     SSFinalizeProc                     finalize;
  161.  
  162.     SSInquireAdapterProc             inquireAdapter;
  163.     SSInquireSocketProc             inquireSocket;
  164.     SSGetSocketProc                 getSocket;
  165.     SSSetSocketProc                 setSocket;
  166.     SSResetSocketProc                 resetSocket;
  167.     SSGetStatusProc                 getStatus;
  168.     SSInquireWindowProc             inquireWindow;
  169.     SSGetWindowProc                 getWindow;
  170.     SSSetWindowProc                 setWindow;
  171.     SSGetWindowOffsetProc             getWindowOffset;
  172.     SSSetWindowOffsetProc             setWindowOffset;
  173.     SSInquireBridgeWindowProc         inquireBridgeWindow;
  174.     SSGetBridgeWindowProc             getBridgeWindow;
  175.     SSSetBridgeWindowProc             setBridgeWindow;
  176.     SSGetInterruptSetMemberProc     getInterruptSetMember;
  177.     SSEjectCardProc                 ejectCard;
  178. };
  179. typedef struct PCCardAdapterPluginDispatchTable PCCardAdapterPluginDispatchTable;
  180. typedef PCCardAdapterPluginDispatchTable * PCCardAdapterPluginDispatchTablePtr;
  181.  
  182. #if PRAGMA_STRUCT_ALIGN
  183.     #pragma options align=reset
  184. #elif PRAGMA_STRUCT_PACKPUSH
  185.     #pragma pack(pop)
  186. #elif PRAGMA_STRUCT_PACK
  187.     #pragma pack()
  188. #endif
  189.  
  190. #ifdef PRAGMA_IMPORT_OFF
  191. #pragma import off
  192. #elif PRAGMA_IMPORT
  193. #pragma import reset
  194. #endif
  195.  
  196. #ifdef __cplusplus
  197. }
  198. #endif
  199.  
  200. #endif /* __PCCARDADAPTERPLUGIN__ */
  201.  
  202.